IRIX Base Documentation 2002 November/SGI IRIX Base Documentation 2002 November.iso/usr/share/catman/p_man/cat3/Vk/VkNode.z/VkNode

Text File | 2002-10-03 | 10.5 KB | 331 lines

VVVVkkkkNNNNooooddddeeee((((3333xxxx))))                                                          VVVVkkkkNNNNooooddddeeee((((3333xxxx))))



NNNNAAAAMMMMEEEE
     VkNode - Base node class used by VkGraph

IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
     VkComponent

HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
     #include <Vk/VkNode.h>

PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
   CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
           VkNode(void);

           VkNode(const char *name,const char *label);

           VkNode(const char *name,
                  VkNode *parent,
                  const char *label);

           virtual void ~VkNode(void);


   SSSSoooorrrrttttiiiinnnngggg
           static void setSortFunction(VkNodeSortFunction f);

           void sortChildren(void);


   AAAAcccccccceeeessssssss FFFFuuuunnnnccccttttiiiioooonnnnssss
           virtual char* label(void);

           int nChildren(void);

           int nParents(void);


   FFFFiiiinnnnddddiiiinnnngggg PPPPaaaarrrreeeennnntttt////CCCChhhhiiiillllddddrrrreeeennnn
           VkNode* findChild(char* name);

           VkNode* findParent(char* name);

           VkNode* child(int index);

           VkNode* parent(int index);


PPPPRRRROOOOTTTTEEEECCCCTTTTEEEEDDDD PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
   BBBBuuuuiiiillllddddiiiinnnngggg wwwwiiiiddddggggeeeettttssss
           virtual void build(Widget parent);






                                                                        PPPPaaaaggggeeee 1111






VVVVkkkkNNNNooooddddeeee((((3333xxxx))))                                                          VVVVkkkkNNNNooooddddeeee((((3333xxxx))))



   ____llllaaaabbbbeeeellll
           char* _label;


CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
          The VkNode class is used by the VkGraph class as a node in an
          abstract graph that can create a widget for display on demand. By
          default, this class creates an XmIconGadget as the widget displayed.
          VkNode is often subclassed to alter the widgets used to display
          nodes, as well as to maintain other data associated with a node.



DDDDEEEERRRRIIIIVVVVIIIINNNNGGGG SSSSUUUUBBBBCCCCLLLLAAAASSSSSSSSEEEESSSS
          Subclasses of VkNode can be created to provide a place to maintain
          additional data, or to change the way the node displays itself in a
          graph. The VkGraph widget calls the VkNode::build() function when it
          needs a widget. Derived classes can override this virtual function
          if desired. This function is expected to create a widget, or
          widgets, assigning the widget or root of a widget hierarchy to the
          __b_a_s_e_W_i_d_g_e_t member. Derived classes should call
          installDestroyHandler() after creating the __b_a_s_e_W_i_d_g_e_t. See
          VkComponent for details. The VkNode class supports a __l_a_b_e_l member
          which may be used to specify a label for a node. If this makes sense
          for the nodes created by a subclass, this member is available.

          Derived classes must be prepared for widgets to be created and
          destroyed dynamically, under the control of the graph widget.



FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
   bbbbuuuuiiiilllldddd(((())))
           virtual void build(Widget parent);


          Create a widget as a child of the specified parent to be displayed
          in a graph.

   VVVVkkkkNNNNooooddddeeee(((())))
           VkNode(void);


          Initialize a VkNode object. A unique name for the object is
          generated automatically.

   VVVVkkkkNNNNooooddddeeee(((())))
           VkNode(const char *name, const char *label);







                                                                        PPPPaaaaggggeeee 2222






VVVVkkkkNNNNooooddddeeee((((3333xxxx))))                                                          VVVVkkkkNNNNooooddddeeee((((3333xxxx))))



          Create a VkNode object with the given name and a label to be used
          when the node is displayed.

   VVVVkkkkNNNNooooddddeeee(((())))
           VkNode(const char *name,
                  VkNode *parent,
                  const char *label);


          Create a VkNode object with a specified parent in a graph. The
          widget has the given name and a label to be used when the node is
          displayed.

   sssseeeettttSSSSoooorrrrttttFFFFuuuunnnnccccttttiiiioooonnnn(((())))
           static void setSortFunction(VkNodeSortFunction f);


          Install a sort function to be used when sorting the graph. The form
          of the sort function is

           int (*VkNodeSortFunction)(VkNode *child1, VkNode *child2);


          The function is expected to conform to qsort conventions: the
          function must return an integer less than, equal to, or greater than
          zero according to whether the first argument is to be considered be
          less than, equal to, or greater than the second.

   ~~~~VVVVkkkkNNNNooooddddeeee(((())))
           virtual void ~VkNode(void);


          Free all memory associated with a VkNode object. The widget is
          destroyed, and all connections to other nodes are removed.  The
          object is also automatically removed from the VkGraph abstract
          graph.

   llllaaaabbbbeeeellll(((())))
           virtual char* label(void);


          Returns any label associated with this node.

   nnnnCCCChhhhiiiillllddddrrrreeeennnn(((())))
           int nChildren(void);


          Returns the number of children connected to this node.

   nnnnPPPPaaaarrrreeeennnnttttssss(((())))





                                                                        PPPPaaaaggggeeee 3333






VVVVkkkkNNNNooooddddeeee((((3333xxxx))))                                                          VVVVkkkkNNNNooooddddeeee((((3333xxxx))))



           int nParents(void);


          Returns the number of parents connected to this node.

   ffffiiiinnnnddddCCCChhhhiiiilllldddd(((())))
           VkNode* findChild(char *name);


          Return the VkNode object for the named child. This function searches
          only immediate children.

   ffffiiiinnnnddddPPPPaaaarrrreeeennnntttt(((())))
           VkNode* findParent(char* name);


          Return the VkNode object for the named parent. This function
          searches only immediate parents.

   cccchhhhiiiilllldddd(((())))
           VkNode* child(int index);


          Returns a child VkNode object by index.

   ppppaaaarrrreeeennnntttt(((())))
           VkNode* parent(int index);


          Returns a parent VkNode object by index.

   ssssoooorrrrttttCCCChhhhiiiillllddddrrrreeeennnn(((())))
           void sortChildren(void);


          Apply the installed sort function to this node's immediate children.

DDDDAAAATTTTAAAA MMMMEEEEMMMMBBBBEEEERRRR DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
   ____llllaaaabbbbeeeellll
           char* _label;


          A character string that can be used to label node, distinct from the
          node's name.

IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
   IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt
          installDestroyHandler(), removeDestroyHandler(), widgetDestroyed(),
          setDefaultResources(), getResources(), manage(), unmanage(),
          baseWidget(), okToQuit(), _name, _baseWidget, _w, deleteCallback





                                                                        PPPPaaaaggggeeee 4444






VVVVkkkkNNNNooooddddeeee((((3333xxxx))))                                                          VVVVkkkkNNNNooooddddeeee((((3333xxxx))))



   IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCaaaallllllllbbbbaaaacccckkkkOOOObbbbjjjjeeeecccctttt
          callCallbacks(), addCallback(), removeCallback(),
          removeAllCallbacks()


KKKKNNNNOOOOWWWWNNNN CCCCLLLLAAAASSSSSSSSEEEESSSS TTTTHHHHAAAATTTT UUUUSSSSEEEE TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
     VkGraph

SSSSEEEEEEEE AAAALLLLSSSSOOOO
     VkComponent, VkGraph, VkNode
     _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
     _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
     _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
     _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF









































                                                                        PPPPaaaaggggeeee 5555